API Documentation
ImageEnvironmentEffect.h
1 // ImageEnvironmentEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
16  class ImageEnvironmentEffect final : public Effect
17  {
18  public :
19 
30 
31  // Getters
35  virtual EFFECT_TYPE getType () const override ;
52 
53  // Setters
95 
96  // Load
100  virtual bool load () override ;
104  virtual void unload () override ;
105 
106  // Utilities
115  } ;
116 }
nkAstraeus::ImageEnvironmentEffect::getSourceProjection
IMAGE_ENVIRONMENT_PROJECTION getSourceProjection() const
nkAstraeus::ImageEnvironmentEffect::getRequiredProjection
static IMAGE_ENVIRONMENT_PROJECTION getRequiredProjection(const ImageEnvironmentEffectInfo &info)
nkAstraeus::ImageEnvironmentEffect::setSourceTexture
void setSourceTexture(nkGraphics::Texture *value)
nkGraphics::Camera
Offers all controls to model a camera.
Definition: Camera.h:12
nkAstraeus::ImageEnvironmentEffect::setSourceProjection
void setSourceProjection(IMAGE_ENVIRONMENT_PROJECTION value)
nkGraphics::Texture
A texture used for rendering, hosted on GPU.
Definition: Texture.h:35
nkAstraeus::EFFECT_TYPE
EFFECT_TYPE
Lists all effects supported.
Definition: EffectType.h:12
nkAstraeus::ImageEnvironmentEffect::~ImageEnvironmentEffect
~ImageEnvironmentEffect()
nkAstraeus::ImageEnvironmentEffectInfo
For internal usage, should not be called.
Definition: ImageEnvironmentEffectInfo.h:14
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: Engine.h:7
nkAstraeus::Effect
Base class for all effects in the component.
Definition: Effect.h:16
nkAstraeus::ImageEnvironmentEffect::setSourceCamera
void setSourceCamera(nkGraphics::Camera *value)
nkAstraeus::ImageEnvironmentEffect::setSourceSampler
void setSourceSampler(nkGraphics::Sampler *value)
nkGraphics::Sampler
Holds all the information needed of a sampler used during rendering.
Definition: Sampler.h:12
nkAstraeus::ImageEnvironmentEffect::getType
virtual EFFECT_TYPE getType() const override
nkAstraeus::ImageEnvironmentEffect::unload
virtual void unload() override
nkAstraeus::IMAGE_ENVIRONMENT_PROJECTION
IMAGE_ENVIRONMENT_PROJECTION
Enumerates the projections supported for a source environment image.
Definition: ImageEnvironmentProjection.h:12
nkAstraeus::ImageEnvironmentEffect::getSourceTexture
nkGraphics::Texture * getSourceTexture() const
nkAstraeus::ImageEnvironmentEffect
Effect using a texture as an input to use it as an environment for the view.
Definition: ImageEnvironmentEffect.h:17
nkAstraeus::ImageEnvironmentEffect::load
virtual bool load() override
nkAstraeus::ImageEnvironmentEffect::getSourceCamera
nkGraphics::Camera * getSourceCamera() const
nkAstraeus::ImageEnvironmentEffect::getSourceSampler
nkGraphics::Sampler * getSourceSampler() const
nkAstraeus::ImageEnvironmentEffect::ImageEnvironmentEffect
ImageEnvironmentEffect()